home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / maximus / msgx_200.zip / FEATURES.DOC < prev    next >
Text File  |  1992-05-04  |  5KB  |  100 lines
  1.      Program    : MsgX
  2.      Description: Message base extraction utility for BBS management
  3.      Author     : Dave Fisher, 1:170/110@fidonet
  4.      
  5.      MsgX is a message extraction program that will select messages
  6.      from any *.MSG or Squish formatted area base and store them in a
  7.      text file or archive.  MsgX can extract messages based on date
  8.      ranges (see /Date) or on specified number of messages (see
  9.      /LimitSize).
  10.      
  11.      MsgX is mainly intended to act as an archival, storage, and
  12.      management tool for message areas (national echos or local) and
  13.      can be run on a daily, weekly, or monthly basis.  The collected
  14.      messages can optionally be compressed into an archive using your
  15.      favorite archival program.  If desired, MsgX will also add an
  16.      entry in the specified FILES.BBS for the newly created archive.
  17.      
  18.      MsgX can archive multiple areas to one archive in a single pass.
  19.      
  20.      Usage:
  21.      
  22.      MsgX [@CtlFile] AreaTag(OutputFile) [, AreaTag(OutputFile), ...]
  23.           /[no]AppendMsgs                   default: NoAppendMsgs
  24.           /Archive = <path+file name>       default: "Constructed"
  25.           /[no]Compress                     default: NoCompress
  26.           /Config = <path+file name>        default: MsgX.Cfg
  27.           /[no]Control                      default: NoControl
  28.           /Dates = (from_date, to_date)     default: All dates
  29.           /Description = "<filesbbs desc>"  default: "Constructed"
  30.           /[no]Kill                         default: NoKill
  31.           /LimitSize = <number of messages> default: No Limit
  32.                OR
  33.           /LimitSize = (threshold, del cnt) default: No Limit
  34.           /[no]Log                          default: NoLog
  35.           /LogFile = <path+file name>       default: None
  36.           /LogLevel = <1..4>                default: 4
  37.           /Margin = <right margin>          default: 79
  38.           /[no]Quiet                        default: NoQuiet
  39.           /[no]Seenbys                      default: NoSeenBys
  40.           /Skip = <number of messages>      default: 0
  41.           /[no]Statistics                   default: Statistics
  42.           /Title = "<header title>"         default: "Constructed"
  43.           /[no]Update                       default: NoUpdate
  44.           /[no]Write                        default: Write
  45.      
  46.      Highlights:
  47.      
  48.   +  Areas can be specified with wildcards.
  49.   
  50.   +  Multiple areas can be specified in one pass.  Messages from these
  51.      areas can either be combined into one file or many separate
  52.      files.
  53.   
  54.   +  Text files created can be automatically archived.
  55.   
  56.   +  FILES.BBS can be automatically updated with descriptive text
  57.      describing what is in the text files.  The descriptive text can
  58.      be defined by you, or constructed by MsgX.
  59.   
  60.   +  The archival program can be defined by you.
  61.   
  62.   +  MsgX is available for DOS or OS/2.
  63.   
  64.   +  Statistical reporting facility available showing traffic usages
  65.      of echo on a day-by-day basis, or summary.
  66.   
  67.   +  Logging facility available in the style of Maximus and
  68.      BinkleyTerm.
  69.   
  70.   +  Macro expansion facility for various aspects of the date range
  71.      being extracted from the message base (month name, julian date,
  72.      etc).  These macros can be used in the resultant text file name,
  73.      archive name, and/or descriptive text within the FILES.BBS file.
  74.   
  75.   +  Messages can be extracted and appended to an existing file of
  76.      messages, or put into a newly created file.  If appending, MsgX
  77.      will extract needed files from the archive first, append the new
  78.      messages, and update the archive.
  79.   
  80.   +  MsgX can be used as a management tool to control the size of the
  81.      message base.  Messages can be extracted when the size of the
  82.      message base exceeds a certain size, and can then be trimmed back
  83.      by a specified number of messages.
  84.   
  85.   +  Date ranges can either be specific, or broadly stated as "current
  86.      month", "previous week", etc.
  87.   
  88.   +  MsgX will look for area definitions within Maximus's message
  89.      control file (MsgArea.Ctl), Squish's configuration file
  90.      (Squish.Cfg), or Areas.Bbs file.
  91.   
  92.   +  Message size only limited by available memory (can be hundreds of
  93.      lines, or several kilobytes).
  94.      
  95.      -------------------------------------------------------------
  96.      
  97.      Current version can always be file-requested as MSGX (for DOS
  98.      version) or MSGXP (for OS/2 version) from 1:170/110.
  99.      
  100.